home *** CD-ROM | disk | FTP | other *** search
/ BBS Toolkit / BBS Toolkit.iso / pc_board / logger14.zip / LOGGER.TXT < prev    next >
Text File  |  1992-04-27  |  15KB  |  310 lines

  1.                                    Logger 1.4
  2.  
  3.                            Written by David E. Basile
  4.  
  5.                                   for PCB 14.5a
  6.  
  7.  
  8. Logger is a program I put together for our BBS.  I wanted something that was
  9. configurable, looked good, and I didn't feel like registering another program. I
  10. hope I accomplished this.  All it does is create a file of the last callers that
  11. can be used a bulletin or displayed each time a user logs on to your board.  You
  12. can also use the Super User Select feature which will put a tag by the users
  13. name using certain select criteria.  It also allows you to exempt users from the
  14. log after they have logged on so many times.  Handy for the Co-sysop that logs
  15. on 8 times, one right after another.  It is totally Sysop configurable.
  16.  
  17. **Note: If you are using a previous version of Logger you might want to delete
  18. your bulletin so it will look correct.  No harm if you don't but it may look a
  19. bit funny until the first XX number of callers are selected.
  20.  
  21. **See History for what's new!
  22.  
  23.      Setup is very easy.  Create a file with following information:
  24.  
  25.      Logger.cfg
  26.  
  27.      Line  1: File name to create 
  28.      Line  2: Header information
  29.      Line  3: Location of User file
  30.      Line  4: Proper case
  31.      Line  5: Number of calls to be logged
  32.      Line  6: Header Color
  33.      Line  7: Line Color
  34.      Line  8: Time Color
  35.      Line  9: Date Color
  36.      Line 10: User Color
  37.      Line 11: City/State Color
  38.      Line 12: Speed Color
  39.      Line 13: Node Color
  40.      Line 14: Caller Flag
  41.      Line 15: CLS Flag
  42.      Line 16: Super User Select Flag
  43.      Line 17: Select Value
  44.      Line 18: Select Character
  45.      Line 19: Select Text Line 1
  46.      Line 20: Select Text Line 2 (Optional)
  47.      Line 21: Select Character Color
  48.      Line 22: Select Text Color
  49.      Line 23: Exempt User Flag
  50.      Line 24: Exempt User File Location
  51.  
  52. Line 1: The name of the file you wish to create.  You can give a full path and
  53. file name like C:\PCB\GEN\LASTCALL.
  54.  
  55. Line 2: You can put any text here you want.  If you set line 5 to the last 20
  56. callers you could use "My BBS last 20 Callers" or what ever you want.  Text is
  57. center automaticly.
  58.  
  59. Line 3: The location and name of the PCB users file.  This is only used to READ
  60. the users City and State.  I have let the sysop tell Logger where to find it
  61. instead of having Logger trying to locate it.  It also may help sysops who don't
  62. use the default of C:\PCB\MAIN\USERS.
  63.  
  64. Line 4: Proper Case Flag.  If set to 1 then the users name, city and state will
  65. be in proper case, ie; David Basile and if set to 0 these fields will be in all
  66. upper case.
  67.  
  68. Line 5: Number of calls you wish to have logged.  1 to 50.  We use 10 because we
  69. really don't want to make a user wade through 4 pages of last callers.  If you
  70. use 50 I suggest making it a bulletin.
  71.  
  72. Line 6: Header Color using the @X color codes.  This is the color of the header
  73. you enter on line 2.
  74.  
  75. Line 7: Line Color using the @X color codes.  The line is the separator from the
  76. header information and the callers.  I used a sting of '='.
  77.  
  78. Line 8: Time Color using the @X color codes.  This is the color of the time
  79. field.
  80.  
  81. Line 9: Date Color using the @X color codes.  This is the color of the date
  82. field.
  83.  
  84. Line 10: User Color using the @X color codes.  This is the color of the user
  85. field.
  86.  
  87. Line 11: City/State Color using the @X color codes.  This is the color of the
  88. City and State field.
  89.  
  90. Line 12: Speed Color using the @X color codes.  This is the color of the Connect
  91. Speed field.
  92.  
  93. Line 13: Node Color using the @X color codes.  This is the color of the Node
  94. field.
  95.  
  96. Line 14: Caller Flag.  This is used to filter out certain calls.
  97. Set it to 0 to log all calls
  98.           1 to Log all calls except the Sysop
  99.           2 to log all calls except Local
  100.           3 to log all calls except the Sysop AND Local
  101.  
  102. Line 15: CLS Flag.  If you wish to have a @CLS@ added to the file so it will
  103. clear the screen before it is viewed set this to 1.  A 0 will not clear the
  104. screen.
  105.  
  106. Line 16: Super User Select.  Couldn't think of a better name so... If you want
  107. to select users that meet a certain criteria you can use this flag.  The Flags
  108. are as follows:
  109.  
  110.      N  - No Select at all
  111.      S  - Security
  112.      UF - Upload Files
  113.      DF - Download Files
  114.      UB - Upload Bytes
  115.      DB - Download Bytes
  116.  
  117. If you do not wish to use the Select feature then put a N on this line.  A 'S'
  118. will select users by Security, UF by Uploaded files, DF by Downloaded files, UB
  119. by Upload bytes, and DB by download bytes.
  120.  
  121.                              *** IMPORTANT NOTE ***
  122.  
  123. If you set line 16 to N then you must leave lines 17 thru 22 BLANK.  Then enter
  124. line 23.  This will allow you to use the Exempt user flag.  If you use N then
  125. you should have 6 blank lines and then the Exempt user flag.
  126.  
  127. Line 17: Select Value.  Enter the value you wish to compare to for line 16.  If
  128. you select the S and your subscribing users are a level 20 then put 20 on this
  129. line.  If you want to use the uploaded files then you can put number of files a
  130. user has to have uploaded in order to be tagged.  We use 50 on our system.  In
  131. simple terms:
  132.  
  133.      Line 16   Line 17      Users tagged
  134.        S        20          All users equal or greater than level 20
  135.        UF       50          All users who have uploaded 50 or more files
  136.        DF       100         All users who have downloaded 100 or more files
  137.        UB       10000000    All users who have uploaded 10000000 or more
  138.                             bytes
  139.        DB       20000000    All users who have downloaded 20000000 or more
  140.                             bytes
  141.        N        N/A         No users will be selected
  142.  
  143. Line 18: Select Character.  This is the 1 character you wish to use for the tag.
  144. It can be any character you want.  We use the *.
  145.  
  146. Line 19: Select Text Line 1. This is the line of text to describe why users have
  147. been selected.  If you have selected Uploaded files you could use "Denotes users
  148. that have uploaded 50 or more files" (70 Characters max)
  149.  
  150. Line 20: Select Text Line 2 (Optional).  This is the second text line if you
  151. feel you need 2 lines.  If you do not want a second line just leave it blank. We
  152. use "A special thanks from the Sysop.  Thanks for the Support.". (70 Characters
  153. max)
  154.  
  155. Line 21: Select Character Color using the X@ color codes.  This is the Color for
  156. the select character.  We use a High Intensity Blinking White (@X0F) so it will
  157. sort of catch the users eye.
  158.  
  159. Line 22: Select Text Color using the X@ color codes.  This is the color for the
  160. select text.  If you use the second line of text it will be the same color as
  161. the first.
  162.  
  163. Line 23: Exempt User Flag.  Setting this to 1 will allow you to have certain
  164. uses exempt from the Logger Bulletin if they have logged on a number of times. 
  165. I found at times I was logging on to our bbs several times to check something
  166. and the whole log was filled with my name.  This will stop this problem if you
  167. feel it was a problem.  If you set it to 1 then make sure you use line 24.  If
  168. set to 0 then you can save the file here and do not need an entry on line 24.
  169. Setting line 23 to 2 will exempt ALL callers that are listed in the TOMANY.USR
  170. file.  No matter how many times they log on their name will not appear.
  171.  
  172. Line 24: Exempt User File Location.  If you have set line 23 to 1 or 2 then you
  173. must put the full drive\path\filename of the file you wish to use.  We use
  174. C:\UTIL\TOMANY.USR.  This file YOU must create.  It is a simple file format.
  175.  
  176.      Line 1: Number of times to allow entry into the Logger Bulletin
  177.              (Line 1 is required even if you decide to exempt all the callers in
  178.              the TOMANY.USR file.  Logger will just disregard this line)
  179.      Line 2: User Name to exempt
  180.      Line 3: Next user to exempt
  181.      .
  182.      .
  183.      .
  184.  
  185. Line 1 is the number of times to allow a user to be logged until he is exempt. 
  186. If you select 3 then the users name will only appear 3 times, even if they have
  187. logged on 6 times.  Once their name is in the log only 2 times or one time less
  188. from the number you have entered on line 1 then it will be added again.
  189.  
  190. Line(s) 2 - ?? is the user name you wish to exempt.  Case does not matter. 
  191. Since I am just the co-sysop but I do all the maintenance I use my name only but
  192. you can add up to 50 users.
  193.  
  194. Again this feature was added because of the problem I was having.  If you do not
  195. wish to use it then set line 23 to 0 and save the file.
  196.  
  197.  
  198. The finished product will look like this:
  199.  
  200.                          The GALAXY BBS Last 10 callers
  201.  
  202.      Time   Date   User                   City/State           Speed    Node
  203.      =======================================================================
  204.      14:02  04-14  David Basile           Fort Rucker, Al      14400       1
  205.      15:35  04-14  Roger Ramjet           Culver City, In       2400       3
  206.      16:00  04-15  John Doe               San Diego, Ca         1200       2
  207.  
  208.      =======================================================================
  209.      [*] - Denotes users that have uploaded 50 or more files!
  210.            A Special thanks from the Sysop.  Thanks for the support.
  211.  
  212.                       Logger v1.4 Copyright David E. Basile
  213.  
  214. $$Logon.bat:  You will need to create a $$LOGON.BAT if you don't already have
  215. one.  You can put Logger anywhere in your path but you must execute it from the
  216. directory with the PCBOARD.SYS file and you must give it the location of
  217. configuration file.
  218.      
  219.      $$LOGON.BAT
  220.      @ECHO OFF
  221.      LOGGER C:\UTIL\LOGGER.CFG
  222.  
  223. Viewing the file:
  224.  
  225. On our board we wanted the users to see the last callers every time they logged
  226. on.  If you wish to do this here is the setup we used.  Go into PCBSetup and
  227. make sure on File Locations 1 you have a path for your security files.  I didn't
  228. want to crowd the \PCB\GEN directory so I made a directory called SECURITY. 
  229. Next I set up logger to create my file C:\PCB\SECURITY\LASTCALL.   I then
  230. created a security file for each security level we have on the board.  The level
  231. 15 file looks like this: %C:\PCB\SECURITY\LASTCALL.  I just copied 15 to each
  232. level that I had.  Remember if you already have security files you will have to
  233. edit them and not create a new one.  If this is your case you might not want to
  234. use the @CLS@ flag.  Now every time a user logs on they will get the Last
  235. Callers bulletin.  Again if you select to log the last 50 calls then you might
  236. not want to use the security file method because your users will have to go
  237. through several screens.  If you are not sure how to use a security file consult
  238. your PCB Manual, Chapter 12, page 219-220.
  239.  
  240. The caller on the bottom of the list is pushed off, if you have reached your
  241. limit and the new user is placed on top.
  242.  
  243. If you want to have a log on screen as described above and a bulletin then you
  244. have 2 choices.  The first one is to make 2 Logger.Cfg files or copy the log on
  245. screen to the bulletin.  Here is an example of both:
  246.  
  247.      Two Logger.Cfg files
  248.  
  249.      $$LOGON.BAT
  250.      @ECHO OFF
  251.      LOGGER C:\UTIL\LOGGER.CFG
  252.      LOGGER C:\UTIL\LOGGER1.CFG
  253.  
  254.      Coping the bulletin
  255.  
  256.      $$LOGON.BAT
  257.      @ECHO OFF
  258.      LOGGER C:\UTIL\LOGGER.CFG
  259.      COPY C:\PCB\SECURITY\LASTCALL C:\PCB\GEN\BLT99
  260.  
  261. The 2 configuration files are probably the best.  This way you can configure 1
  262. with certain features and the other one with no features.  It is up to you. 
  263. Also you can have create 2 separate bulletins, one for log on and the other for
  264. your bulletin menu.
  265.  
  266. Support:  If you have problems, suggestions or just would like to have a feature
  267. added you can contact me at the GALAXY BBS in Daleville Alabama.  Node 1 205-
  268. 598-9509 HST Dual Standard, Node 2 205-598-6547 HST Dual Standard.
  269.  
  270. Registration: None.  It is free.  Not crippled nor does it say UNREGISTERED
  271. anywhere so feel free to use it as long as you want.
  272.  
  273. Guarantee:  NONE.  Use it at your own risk.  It works fine for us.
  274.  
  275. License Agreement:
  276. Consult your physician before starting this program.  Batteries not included. 
  277. May cause drowsiness.  Must be over 17.  Not available in all states.  Not
  278. responsible for acts of God.  Prices subject to change.  Proof of purchase
  279. required.  Read label before using.  Some assembly required.  Not responsible
  280. for typographical errors.  Some restrictions apply.  Subject to local
  281. regulation.  Warrantee period limited.  Close cover before striking.  No
  282. resemblance to any person, living or dead, is intended.  Subject to
  283. availability.  No COD's.  Sales tax not included.  Local restrictions may apply. 
  284. Shipping & handling extra.  All orders subject to review.  For external use
  285. only.  Do not give to children under 8 years of age.  May cause excitability. 
  286. Avoid alcoholic beverages while using this software.  Use caution while
  287. operating mechanical devices.  If symptoms persist, consult your physician. 
  288. Keep this and all software out of the reach of children.  May be unsuitable for
  289. sensitive people.  Parental guidance suggested.  Do not use this software if you
  290. are currently taking a drug for depression.  Neither the seller not the
  291. manufacture will be liable for any brain damage arising from the use of this
  292. software.  The buyer assumes all risks associated with using this product.  In
  293. case of irritation, flush eyes with cold water and consult your physician.  This
  294. software is not a savings account and is not insured by the Federal Deposit
  295. Insurance Corporation.  Use with adequate ventilation.  Avoid prolonged or
  296. repeated contact with skin.  Contents under pressure; do not puncture or
  297. incinerate.  Store in original containers.  Always replace sleeve before
  298. discarding any computer disk.  Get medical attention if symptoms persist. 
  299. Harmful if swallowed.  Do not remain in enclose areas after use.  Not
  300. responsible if you've fallen and can't get up.  So there!
  301.  
  302.  
  303. Future Enhancements: One Sysop asked me to sort of make the Exempt flag a bit
  304. more versatile.  He wants to be able to exempt a certain number of times in a
  305. day and have not let a users name appear 2 times in a row.  I'll be working on
  306. this for logger 1.4.  The reason behind the first enhancement is he uses it as a
  307. bulletin and with 50 names.  Why show that Snuffy Smith logged on 30 times when
  308. all you want to do is show who logged on that day.  Good idea so I'll try to add
  309. it.
  310.